<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>octant.grid.Gridgen</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="octant-module.html">Package&nbsp;octant</a> ::
        <a href="octant.grid-module.html">Module&nbsp;grid</a> ::
        Class&nbsp;Gridgen
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
      </table>
    </td>
  </tr>
</table>
<!-- ==================== TYPE DESCRIPTION ==================== -->
<h1 class="epydoc">type Gridgen</h1><p class="nomargin-top"><span class="codelink"><a href="octant.grid-pysrc.html#Gridgen">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+    
         |    
     <a href="octant.grid.CGrid-class.html">CGrid</a> --+
             |
            <strong class="uidshort">Gridgen</strong>
</pre>

<hr />
docstring for Gridgen

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span><br />
      delete gridnode object upon deletion</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.grid-pysrc.html#Gridgen.__del__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="octant.grid.Gridgen-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">xbry</span>,
        <span class="summary-sig-arg">ybry</span>,
        <span class="summary-sig-arg">beta</span>,
        <span class="summary-sig-arg">shape</span>,
        <span class="summary-sig-arg">ul_idx</span>=<span class="summary-sig-default">0</span>,
        <span class="summary-sig-arg">focus</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">proj</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">nnodes</span>=<span class="summary-sig-default">14</span>,
        <span class="summary-sig-arg">precision</span>=<span class="summary-sig-default">1e-12</span>,
        <span class="summary-sig-arg">nppe</span>=<span class="summary-sig-default">3</span>,
        <span class="summary-sig-arg">newton</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">thin</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">checksimplepoly</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">verbose</span>=<span class="summary-sig-default">False</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.grid-pysrc.html#Gridgen.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="generate_grid"></a><span class="summary-sig-name">generate_grid</span>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="octant.grid-pysrc.html#Gridgen.generate_grid">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="octant.grid.CGrid-class.html">CGrid</a></code></b>:
      <code><a href="octant.grid.CGrid-class.html#calculate_orthogonality">calculate_orthogonality</a></code>,
      <code><a href="octant.grid.CGrid-class.html#mask_polygon">mask_polygon</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="octant.grid.CGrid-class.html">CGrid</a></code></b>:
      <code><a href="octant.grid.CGrid-class.html#mask">mask</a></code>,
      <code><a href="octant.grid.CGrid-class.html#mask_psi">mask_psi</a></code>,
      <code><a href="octant.grid.CGrid-class.html#mask_u">mask_u</a></code>,
      <code><a href="octant.grid.CGrid-class.html#mask_v">mask_v</a></code>,
      <code><a href="octant.grid.CGrid-class.html#x">x</a></code>,
      <code><a href="octant.grid.CGrid-class.html#y">y</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">xbry</span>,
        <span class="sig-arg">ybry</span>,
        <span class="sig-arg">beta</span>,
        <span class="sig-arg">shape</span>,
        <span class="sig-arg">ul_idx</span>=<span class="sig-default">0</span>,
        <span class="sig-arg">focus</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">proj</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">nnodes</span>=<span class="sig-default">14</span>,
        <span class="sig-arg">precision</span>=<span class="sig-default">1e-12</span>,
        <span class="sig-arg">nppe</span>=<span class="sig-default">3</span>,
        <span class="sig-arg">newton</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">thin</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">checksimplepoly</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">verbose</span>=<span class="sig-default">False</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="octant.grid-pysrc.html#Gridgen.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        <a href="octant.grid.CGrid-class.html#__init__">CGrid.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="octant-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1
    on Mon Apr 20 11:56:30 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
